home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.3 / readline.3 < prev    next >
Encoding:
Text File  |  1995-07-26  |  69.3 KB  |  1,123 lines

  1.  
  2.  
  3.  
  4.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           readline - get a line from a user with editing
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<rrrreeeeaaaaddddlllliiiinnnneeee....hhhh>>>>
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<hhhhiiiissssttttoooorrrryyyy....hhhh>>>>
  14.  
  15.           ttttyyyyppppeeeeddddeeeeffff iiiinnnntttt FFFFuuuunnnnccccttttiiiioooonnnn (((())));;;;
  16.  
  17.           cccchhhhaaaarrrr ****rrrreeeeaaaaddddlllliiiinnnneeee ((((pppprrrroooommmmpppptttt))))
  18.           cccchhhhaaaarrrr ****pppprrrroooommmmpppptttt;;;;
  19.  
  20.           iiiinnnntttt rrrrllll____aaaadddddddd____ddddeeeeffffuuuunnnn ((((nnnnaaaammmmeeee,,,, ffffuuuunnnnccccttttiiiioooonnnn,,,, kkkkeeeeyyyy))))
  21.           cccchhhhaaaarrrr ****nnnnaaaammmmeeee;;;;
  22.           FFFFuuuunnnnccccttttiiiioooonnnn ****ffffuuuunnnnccccttttiiiioooonnnn;;;;
  23.           iiiinnnntttt kkkkeeeeyyyy;;;;
  24.  
  25.           iiiinnnntttt rrrrllll____bbbbiiiinnnndddd____kkkkeeeeyyyy ((((kkkkeeeeyyyy,,,, ffffuuuunnnnccccttttiiiioooonnnn))))
  26.           iiiinnnntttt kkkkeeeeyyyy;;;;
  27.           FFFFuuuunnnnccccttttiiiioooonnnn ****ffffuuuunnnnccccttttiiiioooonnnn;;;;
  28.  
  29.           iiiinnnntttt rrrrllll____uuuunnnnbbbbiiiinnnndddd____kkkkeeeeyyyy ((((kkkkeeeeyyyy))))
  30.           iiiinnnntttt kkkkeeeeyyyy;;;;
  31.  
  32.           iiiinnnntttt rrrrllll____bbbbiiiinnnndddd____kkkkeeeeyyyy____iiiinnnn____mmmmaaaapppp ((((kkkkeeeeyyyy,,,, ffffuuuunnnnccccttttiiiioooonnnn,,,, kkkkeeeeyyyymmmmaaaapppp))))
  33.           iiiinnnntttt kkkkeeeeyyyy;;;;
  34.           FFFFuuuunnnnccccttttiiiioooonnnn ****ffffuuuunnnnccccttttiiiioooonnnn;;;;
  35.           KKKKeeeeyyyymmmmaaaapppp kkkkeeeeyyyymmmmaaaapppp;;;;
  36.  
  37.           iiiinnnntttt rrrrllll____uuuunnnnbbbbiiiinnnndddd____kkkkeeeeyyyy____iiiinnnn____mmmmaaaapppp ((((kkkkeeeeyyyy,,,, kkkkeeeeyyyymmmmaaaapppp))))
  38.           iiiinnnntttt kkkkeeeeyyyy;;;;
  39.           KKKKeeeeyyyymmmmaaaapppp kkkkeeeeyyyymmmmaaaapppp;;;;
  40.  
  41.           iiiinnnntttt rrrrllll____mmmmaaaaccccrrrroooo____bbbbiiiinnnndddd ((((kkkkeeeeyyyysssseeeeqqqq,,,, mmmmaaaaccccrrrroooo,,,, kkkkeeeeyyyymmmmaaaapppp))))
  42.           cccchhhhaaaarrrr ****kkkkeeeeyyyysssseeeeqqqq,,,, ****mmmmaaaaccccrrrroooo;;;;
  43.           KKKKeeeeyyyymmmmaaaapppp kkkkeeeeyyyymmmmaaaapppp;;;;
  44.  
  45.           iiiinnnntttt rrrrllll____vvvvaaaarrrriiiiaaaabbbblllleeee____bbbbiiiinnnndddd ((((vvvvaaaarrrriiiiaaaabbbblllleeee,,,, vvvvaaaalllluuuueeee))))
  46.           cccchhhhaaaarrrr ****vvvvaaaarrrriiiiaaaabbbblllleeee,,,, ****vvvvaaaalllluuuueeee;;;;
  47.  
  48.           iiiinnnntttt rrrrllll____ppppaaaarrrrsssseeee____aaaannnndddd____bbbbiiiinnnndddd ((((lllliiiinnnneeee))))
  49.           cccchhhhaaaarrrr ****lllliiiinnnneeee;;;;
  50.  
  51.           iiiinnnntttt rrrrllll____ttttrrrraaaannnnssssllllaaaatttteeee____kkkkeeeeyyyysssseeeeqqqq ((((kkkkeeeeyyyysssseeeeqqqq,,,, aaaarrrrrrrraaaayyyy,,,, lllleeeennnn))))
  52.           cccchhhhaaaarrrr ****kkkkeeeeyyyysssseeeeqqqq,,,, ****aaaarrrrrrrraaaayyyy;;;;
  53.           iiiinnnntttt ****lllleeeennnn;;;;
  54.  
  55.           FFFFuuuunnnnccccttttiiiioooonnnn ****rrrrllll____nnnnaaaammmmeeeedddd____ffffuuuunnnnccccttttiiiioooonnnn ((((ccccoooommmmmmmmaaaannnndddd))))
  56.           cccchhhhaaaarrrr ****ccccoooommmmmmmmaaaannnndddd;;;;
  57.  
  58.           FFFFuuuunnnnccccttttiiiioooonnnn ****rrrrllll____ffffuuuunnnnccccttttiiiioooonnnn____ooooffff____kkkkeeeeyyyysssseeeeqqqq ((((kkkkeeeeyyyysssseeeeqqqq,,,, kkkkeeeeyyyymmmmaaaapppp,,,, ttttyyyyppppeeee))))
  59.           cccchhhhaaaarrrr ****kkkkeeeeyyyysssseeeeqqqq;;;;
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 7/10/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  71.  
  72.  
  73.  
  74.           KKKKeeeeyyyymmmmaaaapppp kkkkeeeeyyyymmmmaaaapppp;;;;
  75.           iiiinnnntttt ****ttttyyyyppppeeee;;;;
  76.  
  77.           cccchhhhaaaarrrr ********rrrrllll____iiiinnnnvvvvooookkkkiiiinnnngggg____kkkkeeeeyyyysssseeeeqqqqssss ((((ffffuuuunnnnccccttttiiiioooonnnn))))
  78.           FFFFuuuunnnnccccttttiiiioooonnnn ****ffffuuuunnnnccccttttiiiioooonnnn;;;;
  79.  
  80.           cccchhhhaaaarrrr ********rrrrllll____iiiinnnnvvvvooookkkkiiiinnnngggg____kkkkeeeeyyyysssseeeeqqqqssss____iiiinnnn____mmmmaaaapppp ((((ffffuuuunnnnccccttttiiiioooonnnn,,,, kkkkeeeeyyyymmmmaaaapppp))))
  81.           FFFFuuuunnnnccccttttiiiioooonnnn ****ffffuuuunnnnccccttttiiiioooonnnn;;;;
  82.           KKKKeeeeyyyymmmmaaaapppp kkkkeeeeyyyymmmmaaaapppp;;;;
  83.  
  84.           vvvvooooiiiidddd rrrrllll____ffffuuuunnnnccccttttiiiioooonnnn____dddduuuummmmppppeeeerrrr ((((rrrreeeeaaaaddddaaaabbbblllleeee))))
  85.           iiiinnnntttt rrrreeeeaaaaddddaaaabbbblllleeee;;;;
  86.  
  87.           cccchhhhaaaarrrr ********rrrrllll____ffffuuuunnnnmmmmaaaapppp____nnnnaaaammmmeeeessss (((())))
  88.  
  89.      CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  90.           Readline is Copyright (C) 1989, 1991 by the Free Software
  91.           Foundation, Inc.
  92.  
  93.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  94.           rrrreeeeaaaaddddlllliiiinnnneeee will read a line from the terminal and return it,
  95.           using pppprrrroooommmmpppptttt as a prompt.  If pppprrrroooommmmpppptttt is null, no prompt is
  96.           issued.  The line returned is allocated with _m_a_l_l_o_c(3), so
  97.           the caller must free it when finished.  The line returned
  98.           has the final newline removed, so only the text of the line
  99.           remains.
  100.  
  101.           rrrreeeeaaaaddddlllliiiinnnneeee offers editing capabilities while the user is
  102.           entering the line.  By default, the line editing commands
  103.           are similar to those of emacs.  A vi-style line editing
  104.           interface is also available.
  105.  
  106.           In the following descriptions, kkkkeeeeyyyymmmmaaaapppp can be one of
  107.           _e_m_a_c_s__k_e_y_m_a_p, _e_m_a_c_s__m_e_t_a__k_e_y_m_a_p, _e_m_a_c_s__c_t_l_x__k_e_y_m_a_p,
  108.           _v_i__i_n_s_e_r_t_i_o_n__k_e_y_m_a_p, _o_r _v_i__m_o_v_e_m_e_n_t__k_e_y_m_a_p.
  109.  
  110.           rrrrllll____aaaadddddddd____ddddeeeeffffuuuunnnn makes nnnnaaaammmmeeee appear as a bindable readline
  111.           command, and makes ffffuuuunnnnccccttttiiiioooonnnn be the function called when that
  112.           command is invoked.  If kkkkeeeeyyyy is not -1, it is bound to
  113.           ffffuuuunnnnccccttttiiiioooonnnn in the current keymap.
  114.  
  115.           rrrrllll____bbbbiiiinnnndddd____kkkkeeeeyyyy causes kkkkeeeeyyyy to invoke ffffuuuunnnnccccttttiiiioooonnnn.  The binding is
  116.           made in the current keymap.
  117.  
  118.           rrrrllll____uuuunnnnbbbbiiiinnnndddd____kkkkeeeeyyyy removes the binding for kkkkeeeeyyyy in the current
  119.           keymap.
  120.  
  121.           rrrrllll____bbbbiiiinnnndddd____kkkkeeeeyyyy____iiiinnnn____mmmmaaaapppp makes the kkkkeeeeyyyy entry in kkkkeeeeyyyymmmmaaaapppp invoke
  122.           ffffuuuunnnnccccttttiiiioooonnnn.
  123.  
  124.           rrrrllll____uuuunnnnbbbbiiiinnnndddd____kkkkeeeeyyyy____iiiinnnn____mmmmaaaapppp removes the binding for kkkkeeeeyyyy in keymap
  125.           kkkkeeeeyyyymmmmaaaapppp.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 7/10/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  137.  
  138.  
  139.  
  140.           rrrrllll____mmmmaaaaccccrrrroooo____bbbbiiiinnnndddd makes kkkkeeeeyyyysssseeeeqqqq insert the string mmmmaaaaccccrrrroooo.  The
  141.           binding is performed in kkkkeeeeyyyymmmmaaaapppp.
  142.  
  143.           rrrrllll____vvvvaaaarrrriiiiaaaabbbblllleeee____bbbbiiiinnnndddd sets the value of the readline variable
  144.           vvvvaaaarrrriiiiaaaabbbblllleeee to vvvvaaaalllluuuueeee.
  145.  
  146.           rrrrllll____ppppaaaarrrrsssseeee____aaaannnndddd____bbbbiiiinnnndddd takes as an argument a line of the same
  147.           form as the readline startup file (see IIIINNNNIIIITTTTIIIIAAAALLLLIIIIZZZZAAAATTTTIIIIOOOONNNN FFFFIIIILLLLEEEE
  148.           below) and executes the commands therein.
  149.  
  150.           rrrrllll____ttttrrrraaaannnnssssllllaaaatttteeee____kkkkeeeeyyyysssseeeeqqqq converts kkkkeeeeyyyysssseeeeqqqq into a new string,
  151.           storing the result in aaaarrrrrrrraaaayyyy.  This translates control and
  152.           meta prefixes and the readline character escape sequences
  153.           (see KKKKeeeeyyyy BBBBiiiinnnnddddiiiinnnnggggssss below).  The length of the translated
  154.           sequence is returned in ****lllleeeennnn.
  155.  
  156.           rrrrllll____nnnnaaaammmmeeeedddd____ffffuuuunnnnccccttttiiiioooonnnn returns the function that is executed when
  157.           the readline command ccccoooommmmmmmmaaaannnndddd is invoked.
  158.  
  159.           rrrrllll____ffffuuuunnnnccccttttiiiioooonnnn____ooooffff____kkkkeeeeyyyysssseeeeqqqq returns the function that is executed
  160.           when kkkkeeeeyyyysssseeeeqqqq is read and kkkkeeeeyyyymmmmaaaapppp is the current keymap.  ttttyyyyppppeeee
  161.           is set to indicate whether the return value corresponds to a
  162.           function, macro, or auxiliary keymap.
  163.  
  164.           rrrrllll____iiiinnnnvvvvooookkkkiiiinnnngggg____kkkkeeeeyyyysssseeeeqqqqssss returns all of the key sequences in the
  165.           current keymap that invoke ffffuuuunnnnccccttttiiiioooonnnn.
  166.  
  167.           rrrrllll____iiiinnnnvvvvooookkkkiiiinnnngggg____kkkkeeeeyyyysssseeeeqqqqssss____iiiinnnn____mmmmaaaapppp returns all of the key sequences
  168.           in kkkkeeeeyyyymmmmaaaapppp that invoke ffffuuuunnnnccccttttiiiioooonnnn.
  169.  
  170.           rrrrllll____ffffuuuunnnnccccttttiiiioooonnnn____dddduuuummmmppppeeeerrrr prints all of the readline functions and
  171.           their bindings to the readline output stream.  If rrrreeeeaaaaddddaaaabbbblllleeee
  172.           is non-zero, the output is formattted so that it can be read
  173.           back in to restore the bindings.
  174.  
  175.           rrrrllll____ffffuuuunnnnmmmmaaaapppp____nnnnaaaammmmeeeessss returns an array of all known readline
  176.           bindable function names.  The array is sorted.
  177.  
  178.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  179.           rrrreeeeaaaaddddlllliiiinnnneeee returns the text of the line read.  A blank line
  180.           returns the empty string.  If EEEEOOOOFFFF is encountered while
  181.           reading a line, and the line is empty, NNNNUUUULLLLLLLL is returned.  If
  182.           an EEEEOOOOFFFF is read with a non-empty line, it is treated as a
  183.           newline.
  184.  
  185.           Unless otherwise stated, the other functions return 0 on
  186.           success and non-zero on failure.
  187.  
  188.      NNNNOOOOTTTTAAAATTTTIIIIOOOONNNN
  189.           An emacs-style notation is used to denote keystrokes.
  190.           Control keys are denoted by C-_k_e_y, e.g., C-n means
  191.           Control-N.  Similarly, _m_e_t_a keys are denoted by M-_k_e_y, so
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 7/10/95)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  203.  
  204.  
  205.  
  206.           M-x means Meta-X.  (On keyboards without a _m_e_t_a key, M-_x
  207.           means ESC _x, i.e., press the Escape key then the _x key.
  208.           This makes ESC the _m_e_t_a _p_r_e_f_i_x.  The combination M-C-_x means
  209.           ESC-Control-_x, or press the Escape key then hold the Control
  210.           key while pressing the _x key.)
  211.  
  212.           Readline commands may be given numeric _a_r_g_u_m_e_n_t_s, which
  213.           normally act as a repeat count.  Sometimes, however, it is
  214.           the sign of the argument that is significant.  Passing a
  215.           negative argument to a command that acts in the forward
  216.           direction (e.g., kkkkiiiillllllll----lllliiiinnnneeee) causes that command to act in a
  217.           backward direction.  Commands whose behavior with arguments
  218.           deviates from this are noted.
  219.  
  220.           When a command is described as _k_i_l_l_i_n_g text, the text
  221.           deleted is saved for possible future retrieval (_y_a_n_k_i_n_g).
  222.           The killed text is saved in a _k_i_l_l-_r_i_n_g.  Consecutive kills
  223.           cause the text to be accumulated into one unit, which can be
  224.           yanked all at once. Commands which do not kill text separate
  225.           the chunks of text on the kill-ring.
  226.  
  227.      IIIINNNNIIIITTTTIIIIAAAALLLLIIIIZZZZAAAATTTTIIIIOOOONNNN FFFFIIIILLLLEEEE
  228.           Readline is customized by putting commands in an
  229.           initialization file.  The name of this file is taken from
  230.           the value of the IIIINNNNPPPPUUUUTTTTRRRRCCCC variable.  If that variable is
  231.           unset, the default is ~/._i_n_p_u_t_r_c.  When a program which uses
  232.           the readline library starts up, the init file is read, and
  233.           the key bindings and variables are set.  There are only a
  234.           few basic constructs allowed in the readline init file.
  235.           Blank lines are ignored.  Lines beginning with a #### are
  236.           comments.  Lines beginning with a $$$$ indicate conditional
  237.           constructs.  Other lines denote key bindings and variable
  238.           settings.  Each program using this library may add its own
  239.           commands and bindings.
  240.  
  241.           For example, placing
  242.  
  243.                M-Control-u: universal-argument
  244.           or
  245.                C-Meta-u: universal-argument
  246.           into the ~/._i_n_p_u_t_r_c would make M-C-u execute the readline
  247.           command _u_n_i_v_e_r_s_a_l-_a_r_g_u_m_e_n_t.
  248.  
  249.           The following symbolic character names are recognized while
  250.           processing key bindings: _R_U_B_O_U_T, _D_E_L, _E_S_C, _L_F_D, _N_E_W_L_I_N_E,
  251.           _R_E_T, _R_E_T_U_R_N, _S_P_C, _S_P_A_C_E, and _T_A_B.  In addition to command
  252.           names, readline allows keys to be bound to a string that is
  253.           inserted when the key is pressed (a _m_a_c_r_o).
  254.  
  255.         KKKKeeeeyyyy BBBBiiiinnnnddddiiiinnnnggggssss
  256.           The syntax for controlling key bindings in the ~/._i_n_p_u_t_r_c
  257.           file is simple.  All that is required is the name of the
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 7/10/95)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  269.  
  270.  
  271.  
  272.           command or the text of a macro and a key sequence to which
  273.           it should be bound. The name may be specified in one of two
  274.           ways: as a symbolic key name, possibly with _M_e_t_a- or
  275.           _C_o_n_t_r_o_l- prefixes, or as a key sequence.  When using the
  276.           form kkkkeeeeyyyynnnnaaaammmmeeee:_f_u_n_c_t_i_o_n-_n_a_m_e or _m_a_c_r_o, _k_e_y_n_a_m_e is the name of
  277.           a key spelled out in English.  For example:
  278.  
  279.                Control-u: universal-argument
  280.                Meta-Rubout: backward-kill-word
  281.                Control-o: ">&output"
  282.  
  283.           In the above example, _C-_u is bound to the function
  284.           uuuunnnniiiivvvveeeerrrrssssaaaallll----aaaarrrrgggguuuummmmeeeennnntttt, _M-_D_E_L is bound to the function
  285.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----kkkkiiiillllllll----wwwwoooorrrrdddd, and _C-_o is bound to run the macro
  286.           expressed on the right hand side (that is, to insert the
  287.           text >&_o_u_t_p_u_t into the line).
  288.  
  289.           In the second form, """"kkkkeeeeyyyysssseeeeqqqq"""":_f_u_n_c_t_i_o_n-_n_a_m_e or _m_a_c_r_o, kkkkeeeeyyyysssseeeeqqqq
  290.           differs from kkkkeeeeyyyynnnnaaaammmmeeee above in that strings denoting an
  291.           entire key sequence may be specified by placing the sequence
  292.           within double quotes.  Some GNU Emacs style key escapes can
  293.           be used, as in the following example.
  294.  
  295.                "\C-u": universal-argument
  296.                "\C-x\C-r": re-read-init-file
  297.                "\e[11~": "Function Key 1"
  298.  
  299.           In this example, _C-_u is again bound to the function
  300.           uuuunnnniiiivvvveeeerrrrssssaaaallll----aaaarrrrgggguuuummmmeeeennnntttt.  _C-_x _C-_r is bound to the function
  301.           rrrreeee----rrrreeeeaaaadddd----iiiinnnniiiitttt----ffffiiiilllleeee, and _E_S_C [ _1 _1 ~ is bound to insert the
  302.           text FFFFuuuunnnnccccttttiiiioooonnnn KKKKeeeeyyyy 1111.  The full set of escape sequences is
  303.  
  304.                \\\\CCCC----  control prefix
  305.  
  306.                \\\\MMMM----  meta prefix
  307.  
  308.                \\\\eeee   an escape character
  309.  
  310.                \\\\\\\\   backslash
  311.  
  312.                \\\\""""   literal "
  313.  
  314.                \\\\''''   literal '
  315.  
  316.           When entering the text of a macro, single or double quotes
  317.           should be used to indicate a macro definition.  Unquoted
  318.           text is assumed to be a function name.  Backslash will quote
  319.           any character in the macro text, including " and '.
  320.  
  321.           BBBBaaaasssshhhh allows the current readline key bindings to be
  322.           displayed or modified with the bbbbiiiinnnndddd builtin command.  The
  323.           editing mode may be switched during interactive use by using
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 7/10/95)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  335.  
  336.  
  337.  
  338.           the ----oooo option to the sssseeeetttt builtin command.  Other programs
  339.           using this library provide similar mechanisms.  The _i_n_p_u_t_r_c
  340.           file may be edited and re-read if a program does not provide
  341.           any other means to incorporate new bindings.
  342.  
  343.         VVVVaaaarrrriiiiaaaabbbblllleeeessss
  344.           Readline has variables that can be used to further customize
  345.           its behavior.  A variable may be set in the _i_n_p_u_t_r_c file
  346.           with a statement of the form
  347.  
  348.                sssseeeetttt _v_a_r_i_a_b_l_e-_n_a_m_e _v_a_l_u_e
  349.  
  350.           Except where noted, readline variables can take the values
  351.           OOOOnnnn or OOOOffffffff.  The variables and their default values are:
  352.  
  353.           hhhhoooorrrriiiizzzzoooonnnnttttaaaallll----ssssccccrrrroooollllllll----mmmmooooddddeeee ((((OOOOffffffff))))
  354.                When set to OOOOnnnn, makes readline use a single line for
  355.                display, scrolling the input horizontally on a single
  356.                screen line when it becomes longer than the screen
  357.                width rather than wrapping to a new line.
  358.           eeeeddddiiiittttiiiinnnngggg----mmmmooooddddeeee ((((eeeemmmmaaaaccccssss))))
  359.                Controls whether readline begins with a set of key
  360.                bindings similar to _e_m_a_c_s or _v_i.  eeeeddddiiiittttiiiinnnngggg----mmmmooooddddeeee can be
  361.                set to either eeeemmmmaaaaccccssss or vvvviiii.
  362.           mmmmaaaarrrrkkkk----mmmmooooddddiiiiffffiiiieeeedddd----lllliiiinnnneeeessss ((((OOOOffffffff))))
  363.                If set to OOOOnnnn, history lines that have been modified are
  364.                displayed with a preceding asterisk (****).
  365.           bbbbeeeellllllll----ssssttttyyyylllleeee ((((aaaauuuuddddiiiibbbblllleeee))))
  366.                Controls what happens when readline wants to ring the
  367.                terminal bell.  If set to nnnnoooonnnneeee, readline never rings
  368.                the bell.  If set to vvvviiiissssiiiibbbblllleeee, readline uses a visible
  369.                bell if one is available.  If set to aaaauuuuddddiiiibbbblllleeee, readline
  370.                attempts to ring the terminal's bell.
  371.           ccccoooommmmmmmmeeeennnntttt----bbbbeeeeggggiiiinnnn ((((````````####''''''''))))
  372.                The string that is inserted in vvvviiii mode when the
  373.                vvvviiii----ccccoooommmmmmmmeeeennnntttt command is executed.
  374.           mmmmeeeettttaaaa----ffffllllaaaagggg ((((OOOOffffffff))))
  375.                If set to OOOOnnnn, readline will enable eight-bit input
  376.                (that is, it will not strip the high bit from the
  377.                characters it reads), regardless of what the terminal
  378.                claims it can support.
  379.           ccccoooonnnnvvvveeeerrrrtttt----mmmmeeeettttaaaa ((((OOOOnnnn))))
  380.                If set to OOOOnnnn, readline will convert characters with the
  381.                eighth bit set to an ASCII key sequence by stripping
  382.                the eighth bit and prepending an escape character (in
  383.                effect, using escape as the _m_e_t_a _p_r_e_f_i_x).
  384.           oooouuuuttttppppuuuutttt----mmmmeeeettttaaaa ((((OOOOffffffff))))
  385.                If set to OOOOnnnn, readline will display characters with the
  386.                eighth bit set directly rather than as a meta-prefixed
  387.                escape sequence.
  388.           ccccoooommmmpppplllleeeettttiiiioooonnnn----qqqquuuueeeerrrryyyy----iiiitttteeeemmmmssss ((((111100000000))))
  389.                This determines when the user is queried about viewing
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 7/10/95)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  401.  
  402.  
  403.  
  404.                the number of possible completions generated by the
  405.                ppppoooossssssssiiiibbbblllleeee----ccccoooommmmpppplllleeeettttiiiioooonnnnssss command.  It may be set to any
  406.                integer value greater than or equal to zero.  If the
  407.                number of possible completions is greater than or equal
  408.                to the value of this variable, the user is asked
  409.                whether or not he wishes to view them; otherwise they
  410.                are simply listed on the terminal.
  411.           kkkkeeeeyyyymmmmaaaapppp ((((eeeemmmmaaaaccccssss))))
  412.                Set the current readline keymap.  The set of legal
  413.                keymap names is _e_m_a_c_s, _e_m_a_c_s-_s_t_a_n_d_a_r_d, _e_m_a_c_s-_m_e_t_a,
  414.                _e_m_a_c_s-_c_t_l_x, _v_i, _v_i-_m_o_v_e, _v_i-_c_o_m_m_a_n_d, and _v_i-_i_n_s_e_r_t.  _v_i
  415.                is equivalent to _v_i-_c_o_m_m_a_n_d; _e_m_a_c_s is equivalent to
  416.                _e_m_a_c_s-_s_t_a_n_d_a_r_d.  The default value is _e_m_a_c_s; the value
  417.                of eeeeddddiiiittttiiiinnnngggg----mmmmooooddddeeee also affects the default keymap.
  418.           sssshhhhoooowwww----aaaallllllll----iiiiffff----aaaammmmbbbbiiiigggguuuuoooouuuussss ((((OOOOffffffff))))
  419.                This alters the default behavior of the completion
  420.                functions.  If set to oooonnnn, words which have more than
  421.                one possible completion cause the matches to be listed
  422.                immediately instead of ringing the bell.
  423.           eeeexxxxppppaaaannnndddd----ttttiiiillllddddeeee ((((OOOOffffffff))))
  424.                If set to oooonnnn, tilde expansion is performed when
  425.                readline attempts word completion.
  426.  
  427.         CCCCoooonnnnddddiiiittttiiiioooonnnnaaaallll CCCCoooonnnnssssttttrrrruuuuccccttttssss
  428.           Readline implements a facility similar in spirit to the
  429.           conditional compilation features of the C preprocessor which
  430.           allows key bindings and variable settings to be performed as
  431.           the result of tests.  There are three parser directives
  432.           used.
  433.  
  434.           $$$$iiiiffff  The $$$$iiiiffff construct allows bindings to be made based on
  435.                the editing mode, the terminal being used, or the
  436.                application using readline.  The text of the test
  437.                extends to the end of the line; no characters are
  438.                required to isolate it.
  439.  
  440.                mmmmooooddddeeee The mmmmooooddddeeee==== form of the $$$$iiiiffff directive is used to
  441.                     test whether readline is in emacs or vi mode.
  442.                     This may be used in conjunction with the sssseeeetttt
  443.                     kkkkeeeeyyyymmmmaaaapppp command, for instance, to set bindings in
  444.                     the _e_m_a_c_s-_s_t_a_n_d_a_r_d and _e_m_a_c_s-_c_t_l_x keymaps only if
  445.                     readline is starting out in emacs mode.
  446.  
  447.                tttteeeerrrrmmmm The tttteeeerrrrmmmm==== form may be used to include terminal-
  448.                     specific key bindings, perhaps to bind the key
  449.                     sequences output by the terminal's function keys.
  450.                     The word on the right side of the ==== is tested
  451.                     against the full name of the terminal and the
  452.                     portion of the terminal name before the first ----.
  453.                     This allows _s_u_n to match both _s_u_n and _s_u_n-_c_m_d, for
  454.                     instance.
  455.  
  456.  
  457.  
  458.  
  459.      Page 7                                          (printed 7/10/95)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  467.  
  468.  
  469.  
  470.                aaaapppppppplllliiiiccccaaaattttiiiioooonnnn
  471.                     The aaaapppppppplllliiiiccccaaaattttiiiioooonnnn construct is used to include
  472.                     application-specific settings.  Each program using
  473.                     the readline library sets the _a_p_p_l_i_c_a_t_i_o_n _n_a_m_e,
  474.                     and an initialization file can test for a
  475.                     particular value.  This could be used to bind key
  476.                     sequences to functions useful for a specific
  477.                     program.  For instance, the following command adds
  478.                     a key sequence that quotes the current or previous
  479.                     word in Bash:
  480.                     $$$$iiiiffff bash
  481.                     # Quote the current or previous word
  482.                     "\C-xq": "\eb\"\ef\""
  483.                     $$$$eeeennnnddddiiiiffff
  484.  
  485.           $$$$eeeennnnddddiiiiffff
  486.                This command, as you saw in the previous example,
  487.                terminates an $$$$iiiiffff command.
  488.  
  489.           $$$$eeeellllsssseeee
  490.                Commands in this branch of the $$$$iiiiffff directive are
  491.                executed if the test fails.
  492.  
  493.      EEEEDDDDIIIITTTTIIIINNNNGGGG CCCCOOOOMMMMMMMMAAAANNNNDDDDSSSS
  494.           The following is a list of the names of the commands and the
  495.           default key sequences to which they are bound.
  496.  
  497.         CCCCoooommmmmmmmaaaannnnddddssss ffffoooorrrr MMMMoooovvvviiiinnnngggg
  498.           bbbbeeeeggggiiiinnnnnnnniiiinnnngggg----ooooffff----lllliiiinnnneeee ((((CCCC----aaaa))))
  499.                Move to the start of the current line.
  500.           eeeennnndddd----ooooffff----lllliiiinnnneeee ((((CCCC----eeee))))
  501.                Move to the end of the line.
  502.           ffffoooorrrrwwwwaaaarrrrdddd----cccchhhhaaaarrrr ((((CCCC----ffff))))
  503.                Move forward a character.
  504.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----cccchhhhaaaarrrr ((((CCCC----bbbb))))
  505.                Move back a character.
  506.           ffffoooorrrrwwwwaaaarrrrdddd----wwwwoooorrrrdddd ((((MMMM----ffff))))
  507.                Move forward to the end of the next word.  Words are
  508.                composed of alphanumeric characters (letters and
  509.                digits).
  510.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----wwwwoooorrrrdddd ((((MMMM----bbbb))))
  511.                Move back to the start of this, or the previous, word.
  512.                Words are composed of alphanumeric characters (letters
  513.                and digits).
  514.           cccclllleeeeaaaarrrr----ssssccccrrrreeeeeeeennnn ((((CCCC----llll))))
  515.                Clear the screen leaving the current line at the top of
  516.                the screen.  With an argument, refresh the current line
  517.                without clearing the screen.
  518.           rrrreeeeddddrrrraaaawwww----ccccuuuurrrrrrrreeeennnntttt----lllliiiinnnneeee
  519.                Refresh the current line.  By default, this is unbound.
  520.  
  521.         CCCCoooommmmmmmmaaaannnnddddssss ffffoooorrrr MMMMaaaannnniiiippppuuuullllaaaattttiiiinnnngggg tttthhhheeee HHHHiiiissssttttoooorrrryyyy
  522.  
  523.  
  524.  
  525.      PPPPaaaaggggeeee 8888                                          ((((pppprrrriiiinnnntttteeeedddd 7777////11110000////99995555))))
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  533.  
  534.  
  535.  
  536.           aaaacccccccceeeepppptttt----lllliiiinnnneeee ((((NNNNeeeewwwwlllliiiinnnneeee,,,, RRRReeeettttuuuurrrrnnnn))))
  537.                Accept the line regardless of where the cursor is.  If
  538.                this line is non-empty, add it to the history list. If
  539.                the line is a modified history line, then restore the
  540.                history line to its original state.
  541.           pppprrrreeeevvvviiiioooouuuussss----hhhhiiiissssttttoooorrrryyyy ((((CCCC----pppp))))
  542.                Fetch the previous command from the history list,
  543.                moving back in the list.
  544.           nnnneeeexxxxtttt----hhhhiiiissssttttoooorrrryyyy ((((CCCC----nnnn))))
  545.                Fetch the next command from the history list, moving
  546.                forward in the list.
  547.           bbbbeeeeggggiiiinnnnnnnniiiinnnngggg----ooooffff----hhhhiiiissssttttoooorrrryyyy ((((MMMM----<<<<))))
  548.                Move to the first line in the history.
  549.           eeeennnndddd----ooooffff----hhhhiiiissssttttoooorrrryyyy ((((MMMM---->>>>))))
  550.                Move to the end of the input history, i.e., the line
  551.                currently being entered.
  552.           rrrreeeevvvveeeerrrrsssseeee----sssseeeeaaaarrrrcccchhhh----hhhhiiiissssttttoooorrrryyyy ((((CCCC----rrrr))))
  553.                Search backward starting at the current line and moving
  554.                `up' through the history as necessary.  This is an
  555.                incremental search.
  556.           ffffoooorrrrwwwwaaaarrrrdddd----sssseeeeaaaarrrrcccchhhh----hhhhiiiissssttttoooorrrryyyy ((((CCCC----ssss))))
  557.                Search forward starting at the current line and moving
  558.                `down' through the history as necessary.  This is an
  559.                incremental search.
  560.           nnnnoooonnnn----iiiinnnnccccrrrreeeemmmmeeeennnnttttaaaallll----rrrreeeevvvveeeerrrrsssseeee----sssseeeeaaaarrrrcccchhhh----hhhhiiiissssttttoooorrrryyyy ((((MMMM----pppp))))
  561.                Search backward through the history starting at the
  562.                current line using a non-incremental search for a
  563.                string supplied by the user.
  564.           nnnnoooonnnn----iiiinnnnccccrrrreeeemmmmeeeennnnttttaaaallll----ffffoooorrrrwwwwaaaarrrrdddd----sssseeeeaaaarrrrcccchhhh----hhhhiiiissssttttoooorrrryyyy ((((MMMM----nnnn))))
  565.                Search forward through the history using a
  566.                non-incremental search for a string supplied by the
  567.                user.
  568.           hhhhiiiissssttttoooorrrryyyy----sssseeeeaaaarrrrcccchhhh----ffffoooorrrrwwwwaaaarrrrdddd
  569.                Search forward through the history for the string of
  570.                characters between the start of the current line and
  571.                the current point.  This is a non-incremental search.
  572.                By default, this command is unbound.
  573.           hhhhiiiissssttttoooorrrryyyy----sssseeeeaaaarrrrcccchhhh----bbbbaaaacccckkkkwwwwaaaarrrrdddd
  574.                Search backward through the history for the string of
  575.                characters between the start of the current line and
  576.                the current point.  This is a non-incremental search.
  577.                By default, this command is unbound.
  578.           yyyyaaaannnnkkkk----nnnntttthhhh----aaaarrrrgggg ((((MMMM----CCCC----yyyy))))
  579.                Insert the first argument to the previous command
  580.                (usually the second word on the previous line) at point
  581.                (the current cursor position).  With an argument _n,
  582.                insert the _nth word from the previous command (the
  583.                words in the previous command begin with word 0).  A
  584.                negative argument inserts the _nth word from the end of
  585.                the previous command.
  586.           yyyyaaaannnnkkkk----llllaaaasssstttt----aaaarrrrgggg ((((MMMM----....,,,, MMMM----____))))
  587.                Insert the last argument to the previous command (the
  588.  
  589.  
  590.  
  591.      Page 9                                          (printed 7/10/95)
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  599.  
  600.  
  601.  
  602.                last word on the previous line).  With an argument,
  603.                behave exactly like @code{yank-nth-arg}.
  604.  
  605.         CCCCoooommmmmmmmaaaannnnddddssss ffffoooorrrr CCCChhhhaaaannnnggggiiiinnnngggg TTTTeeeexxxxtttt
  606.           ddddeeeelllleeeetttteeee----cccchhhhaaaarrrr ((((CCCC----dddd))))
  607.                Delete the character under the cursor.  If point is at
  608.                the beginning of the line, there are no characters in
  609.                the line, and the last character typed was not CCCC----dddd,
  610.                then return EEEEOOOOFFFF.
  611.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----ddddeeeelllleeeetttteeee----cccchhhhaaaarrrr ((((RRRRuuuubbbboooouuuutttt))))
  612.                Delete the character behind the cursor.  When given a
  613.                numeric argument, save the deleted text on the
  614.                kill-ring.
  615.           qqqquuuuooootttteeeedddd----iiiinnnnsssseeeerrrrtttt ((((CCCC----qqqq,,,, CCCC----vvvv))))
  616.                Add the next character that you type to the line
  617.                verbatim.  This is how to insert characters like CCCC----qqqq,
  618.                for example.
  619.           ttttaaaabbbb----iiiinnnnsssseeeerrrrtttt ((((MMMM----TTTTAAAABBBB))))
  620.                Insert a tab character.
  621.           sssseeeellllffff----iiiinnnnsssseeeerrrrtttt ((((aaaa,,,, bbbb,,,, AAAA,,,, 1111,,,, !!!!,,,, ............))))
  622.                Insert the character typed.
  623.           ttttrrrraaaannnnssssppppoooosssseeee----cccchhhhaaaarrrrssss ((((CCCC----tttt))))
  624.                Drag the character before point forward over the
  625.                character at point.  Point moves forward as well.  If
  626.                point is at the end of the line, then transpose the two
  627.                characters before point.  Negative arguments don't
  628.                work.
  629.           ttttrrrraaaannnnssssppppoooosssseeee----wwwwoooorrrrddddssss ((((MMMM----tttt))))
  630.                Drag the word behind the cursor past the word in front
  631.                of the cursor moving the cursor over that word as well.
  632.           uuuuppppccccaaaasssseeee----wwwwoooorrrrdddd ((((MMMM----uuuu))))
  633.                Uppercase the current (or following) word.  With a
  634.                negative argument, do the previous word, but do not
  635.                move point.
  636.           ddddoooowwwwnnnnccccaaaasssseeee----wwwwoooorrrrdddd ((((MMMM----llll))))
  637.                Lowercase the current (or following) word.  With a
  638.                negative argument, do the previous word, but do not
  639.                move point.
  640.           ccccaaaappppiiiittttaaaalllliiiizzzzeeee----wwwwoooorrrrdddd ((((MMMM----cccc))))
  641.                Capitalize the current (or following) word.  With a
  642.                negative argument, do the previous word, but do not
  643.                move point.
  644.  
  645.         KKKKiiiilllllllliiiinnnngggg aaaannnndddd YYYYaaaannnnkkkkiiiinnnngggg
  646.           kkkkiiiillllllll----lllliiiinnnneeee ((((CCCC----kkkk))))
  647.                Kill the text from the current cursor position to the
  648.                end of the line.
  649.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----kkkkiiiillllllll----lllliiiinnnneeee ((((CCCC----xxxx RRRRuuuubbbboooouuuutttt))))
  650.                Kill backward to the beginning of the line.
  651.           uuuunnnniiiixxxx----lllliiiinnnneeee----ddddiiiissssccccaaaarrrrdddd ((((CCCC----uuuu))))
  652.                Kill backward from point to the beginning of the line.
  653.           kkkkiiiillllllll----wwwwhhhhoooolllleeee----lllliiiinnnneeee
  654.  
  655.  
  656.  
  657.      Page 10                                         (printed 7/10/95)
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  665.  
  666.  
  667.  
  668.                Kill all characters on the current line, no matter
  669.                where the cursor is.  By default, this is unbound.
  670.           kkkkiiiillllllll----wwwwoooorrrrdddd ((((MMMM----dddd))))
  671.                Kill from the cursor to the end of the current word, or
  672.                if between words, to the end of the next word.  Word
  673.                boundaries are the same as those used by ffffoooorrrrwwwwaaaarrrrdddd----wwwwoooorrrrdddd.
  674.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----kkkkiiiillllllll----wwwwoooorrrrdddd ((((MMMM----RRRRuuuubbbboooouuuutttt))))
  675.                Kill the word behind the cursor.  Word boundaries are
  676.                the same as those used by bbbbaaaacccckkkkwwwwaaaarrrrdddd----wwwwoooorrrrdddd.
  677.           uuuunnnniiiixxxx----wwwwoooorrrrdddd----rrrruuuubbbboooouuuutttt ((((CCCC----wwww))))
  678.                Kill the word behind the cursor, using white space as a
  679.                word boundary.  The word boundaries are different from
  680.                bbbbaaaacccckkkkwwwwaaaarrrrdddd----kkkkiiiillllllll----wwwwoooorrrrdddd.
  681.           ddddeeeelllleeeetttteeee----hhhhoooorrrriiiizzzzoooonnnnttttaaaallll----ssssppppaaaacccceeee
  682.                Delete all spaces and tabs around point.  By default,
  683.                this is unbound.
  684.           yyyyaaaannnnkkkk ((((CCCC----yyyy))))
  685.                Yank the top of the kill ring into the buffer at the
  686.                cursor.
  687.           yyyyaaaannnnkkkk----ppppoooopppp ((((MMMM----yyyy))))
  688.                Rotate the kill-ring, and yank the new top.  Only works
  689.                following yyyyaaaannnnkkkk or yyyyaaaannnnkkkk----ppppoooopppp.
  690.  
  691.         NNNNuuuummmmeeeerrrriiiicccc AAAArrrrgggguuuummmmeeeennnnttttssss
  692.           ddddiiiiggggiiiitttt----aaaarrrrgggguuuummmmeeeennnntttt ((((MMMM----0000,,,, MMMM----1111,,,, ............,,,, MMMM--------))))
  693.                Add this digit to the argument already accumulating, or
  694.                start a new argument.  M-- starts a negative argument.
  695.           uuuunnnniiiivvvveeeerrrrssssaaaallll----aaaarrrrgggguuuummmmeeeennnntttt
  696.                Each time this is executed, the argument count is
  697.                multiplied by four.  The argument count is initially
  698.                one, so executing this function the first time makes
  699.                the argument count four.  By default, this is not bound
  700.                to a key.
  701.  
  702.         CCCCoooommmmpppplllleeeettttiiiinnnngggg
  703.           ccccoooommmmpppplllleeeetttteeee ((((TTTTAAAABBBB))))
  704.                Attempt to perform completion on the text before point.
  705.                The actual completion performed is application-
  706.                specific.  BBBBaaaasssshhhh, for instance, attempts completion
  707.                treating the text as a variable (if the text begins
  708.                with $$$$), username (if the text begins with ~~~~), hostname
  709.                (if the text begins with @@@@), or command (including
  710.                aliases and functions) in turn.  If none of these
  711.                produces a match, filename completion is attempted.
  712.                GGGGddddbbbb, on the other hand, allows completion of program
  713.                functions and variables, and only attempts filename
  714.                completion under certain circumstances.
  715.           ppppoooossssssssiiiibbbblllleeee----ccccoooommmmpppplllleeeettttiiiioooonnnnssss ((((MMMM----????))))
  716.                List the possible completions of the text before point.
  717.           iiiinnnnsssseeeerrrrtttt----ccccoooommmmpppplllleeeettttiiiioooonnnnssss
  718.                Insert all completions of the text before point that
  719.                would have been generated by ppppoooossssssssiiiibbbblllleeee----ccccoooommmmpppplllleeeettttiiiioooonnnnssss.  By
  720.  
  721.  
  722.  
  723.      Page 11                                         (printed 7/10/95)
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  731.  
  732.  
  733.  
  734.                default, this is not bound to a key.
  735.  
  736.         KKKKeeeeyyyybbbbooooaaaarrrrdddd MMMMaaaaccccrrrroooossss
  737.           ssssttttaaaarrrrtttt----kkkkbbbbdddd----mmmmaaaaccccrrrroooo ((((CCCC----xxxx (((())))
  738.                Begin saving the characters typed into the current
  739.                keyboard macro.
  740.           eeeennnndddd----kkkkbbbbdddd----mmmmaaaaccccrrrroooo ((((CCCC----xxxx ))))))))
  741.                Stop saving the characters typed into the current
  742.                keyboard macro and save the definition.
  743.           ccccaaaallllllll----llllaaaasssstttt----kkkkbbbbdddd----mmmmaaaaccccrrrroooo ((((CCCC----xxxx eeee))))
  744.                Re-execute the last keyboard macro defined, by making
  745.                the characters in the macro appear as if typed at the
  746.                keyboard.
  747.  
  748.         MMMMiiiisssscccceeeellllllllaaaannnneeeeoooouuuussss
  749.           rrrreeee----rrrreeeeaaaadddd----iiiinnnniiiitttt----ffffiiiilllleeee ((((CCCC----xxxx CCCC----rrrr))))
  750.                Read in the contents of your init file, and incorporate
  751.                any bindings or variable assignments found there.
  752.           aaaabbbboooorrrrtttt ((((CCCC----gggg))))
  753.                Abort the current editing command and ring the
  754.                terminal's bell (subject to the setting of bbbbeeeellllllll----ssssttttyyyylllleeee).
  755.           ddddoooo----uuuuppppppppeeeerrrrccccaaaasssseeee----vvvveeeerrrrssssiiiioooonnnn ((((MMMM----aaaa,,,, MMMM----bbbb,,,, ............))))
  756.                Run the command that is bound to the corresponding
  757.                uppercase character.
  758.           pppprrrreeeeffffiiiixxxx----mmmmeeeettttaaaa ((((EEEESSSSCCCC))))
  759.                Metafy the next character typed.  EEEESSSSCCCC ffff is equivalent
  760.                to MMMMeeeettttaaaa----ffff.
  761.           uuuunnnnddddoooo ((((CCCC----____,,,, CCCC----xxxx CCCC----uuuu))))
  762.                Incremental undo, separately remembered for each line.
  763.           rrrreeeevvvveeeerrrrtttt----lllliiiinnnneeee ((((MMMM----rrrr))))
  764.                Undo all changes made to this line.  This is like
  765.                typing the uuuunnnnddddoooo command enough times to return the line
  766.                to its initial state.
  767.           ttttiiiillllddddeeee----eeeexxxxppppaaaannnndddd ((((MMMM----~~~~))))
  768.                Perform tilde expansion on the current word.
  769.           dddduuuummmmpppp----ffffuuuunnnnccccttttiiiioooonnnnssss
  770.                Print all of the functions and their key bindings to
  771.                the readline output stream.  If a numeric argument is
  772.                supplied, the output is formatted in such a way that it
  773.                can be made part of an _i_n_p_u_t_r_c file.
  774.           eeeemmmmaaaaccccssss----eeeeddddiiiittttiiiinnnngggg----mmmmooooddddeeee ((((CCCC----eeee))))
  775.                When in vvvviiii editing mode, this causes a switch to eeeemmmmaaaaccccssss
  776.                editing mode.
  777.           vvvviiii----eeeeddddiiiittttiiiinnnngggg----mmmmooooddddeeee ((((MMMM----CCCC----jjjj))))
  778.                When in eeeemmmmaaaaccccssss editing mode, this causes a switch to vvvviiii
  779.                editing mode.
  780.  
  781.      DDDDEEEEFFFFAAAAUUUULLLLTTTT KKKKEEEEYYYY BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS
  782.           The following is a list of the default emacs and vi
  783.           bindings.  Characters with the 8th bit set are written as
  784.           M-<character>, and are referred to as _m_e_t_a_f_i_e_d characters.
  785.           The printable ASCII characters not mentioned in the list of
  786.  
  787.  
  788.  
  789.      Page 12                                         (printed 7/10/95)
  790.  
  791.  
  792.  
  793.  
  794.  
  795.  
  796.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  797.  
  798.  
  799.  
  800.           emacs standard bindings are bound to the _s_e_l_f-_i_n_s_e_r_t
  801.           function, which just inserts the given character into the
  802.           input line.  In vi insertion mode, all characters not
  803.           specifically mentioned are bound to _s_e_l_f-_i_n_s_e_r_t.  Characters
  804.           assigned to signal generation by _s_t_t_y(1) or the terminal
  805.           driver, such as C-Z or C-C, retain that function.  Upper and
  806.           lower case _m_e_t_a_f_i_e_d characters are bound to the same
  807.           function in the emacs mode meta keymap.  The remaining
  808.           characters are unbound, which causes readline to ring the
  809.           bell (subject to the setting of the bbbbeeeellllllll----ssssttttyyyylllleeee variable).
  810.  
  811.         EEEEmmmmaaaaccccssss MMMMooooddddeeee
  812.                 Emacs Standard bindings
  813.  
  814.                 "C-A"                    ->  beginning-of-line
  815.                 "C-B"                    ->  backward-char
  816.                 "C-D"                    ->  delete-char
  817.                 "C-E"                    ->  end-of-line
  818.                 "C-F"                    ->  forward-char
  819.                 "C-G"                    ->  abort
  820.                 "C-H"                    ->  backward-delete-char
  821.                 "C-I"                    ->  complete
  822.                 "C-J"                    ->  accept-line
  823.                 "C-K"                    ->  kill-line
  824.                 "C-L"                    ->  clear-screen
  825.                 "C-M"                    ->  accept-line
  826.                 "C-N"                    ->  next-history
  827.                 "C-P"                    ->  previous-history
  828.                 "C-Q"                    ->  quoted-insert
  829.                 "C-R"                    ->  reverse-search-history
  830.                 "C-S"                    ->  forward-search-history
  831.                 "C-T"                    ->  transpose-chars
  832.                 "C-U"                    ->  unix-line-discard
  833.                 "C-V"                    ->  quoted-insert
  834.                 "C-W"                    ->  unix-word-rubout
  835.                 "C-Y"                    ->  yank
  836.                 "C-_"                    ->  undo
  837.                 " " to "/"               ->  self-insert
  838.                 "0"  to "9"              ->  self-insert
  839.                 ":"  to "~"              ->  self-insert
  840.                 "C-?"                    ->  backward-delete-char
  841.  
  842.                 Emacs Meta bindings
  843.  
  844.                 "M-C-H"                  ->  backward-kill-word
  845.                 "M-C-I"                  ->  tab-insert
  846.                 "M-C-J"                  ->  vi-editing-mode
  847.                 "M-C-M"                  ->  vi-editing-mode
  848.                 "M-C-R"                  ->  revert-line
  849.                 "M-C-Y"                  ->  yank-nth-arg
  850.                 "M-C-["                  ->  complete
  851.                 "M-&"                    ->  tilde-expand
  852.  
  853.  
  854.  
  855.      Page 13                                         (printed 7/10/95)
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  863.  
  864.  
  865.  
  866.                 "M--"                    ->  digit-argument
  867.                 "M-0"                    ->  digit-argument
  868.                 "M-1"                    ->  digit-argument
  869.                 "M-2"                    ->  digit-argument
  870.                 "M-3"                    ->  digit-argument
  871.                 "M-4"                    ->  digit-argument
  872.                 "M-5"                    ->  digit-argument
  873.                 "M-6"                    ->  digit-argument
  874.                 "M-7"                    ->  digit-argument
  875.                 "M-8"                    ->  digit-argument
  876.                 "M-9"                    ->  digit-argument
  877.                 "M-<"                    ->  beginning-of-history
  878.                 "M->"                    ->  end-of-history
  879.                 "M-?"                    ->  possible-completions
  880.                 "M-B"                    ->  backward-word
  881.                 "M-C"                    ->  capitalize-word
  882.                 "M-D"                    ->  kill-word
  883.                 "M-F"                    ->  forward-word
  884.                 "M-L"                    ->  downcase-word
  885.                 "M-N"                    ->  non-incremental-forward-search-history
  886.                 "M-O"                    ->  arrow-key-prefix
  887.                 "M-P"                    ->  non-incremental-reverse-search-history
  888.                 "M-R"                    ->  revert-line
  889.                 "M-T"                    ->  transpose-words
  890.                 "M-U"                    ->  upcase-word
  891.                 "M-Y"                    ->  yank-pop
  892.                 "M-C-Y"                  ->  yank-nth-arg
  893.                 "M-C-?"                  ->  backward-delete-word
  894.  
  895.                 Emacs Control-X bindings
  896.  
  897.                 "C-XC-G"                 ->  abort
  898.                 "C-XC-R"                 ->  re-read-init-file
  899.                 "C-XC-U"                 ->  undo
  900.                 "C-X("                   ->  start-kbd-macro
  901.                 "C-X)"                   ->  end-kbd-macro
  902.                 "C-Xe"                   ->  call-last-kbd-macro
  903.                 "C-XC-?"                 ->  backward-kill-line
  904.  
  905.  
  906.         VVVVIIII MMMMooooddddeeee bbbbiiiinnnnddddiiiinnnnggggssss
  907.                 VI Insert Mode functions
  908.  
  909.                 "C-D"                    ->  vi-eof-maybe
  910.                 "C-H"                    ->  backward-delete-char
  911.                 "C-I"                    ->  complete
  912.                 "C-J"                    ->  accept-line
  913.                 "C-K"                    ->  kill-line
  914.                 "C-L"                    ->  clear-screen
  915.                 "C-M"                    ->  accept-line
  916.                 "C-N"                    ->  next-history
  917.                 "C-P"                    ->  previous-history
  918.  
  919.  
  920.  
  921.      Page 14                                         (printed 7/10/95)
  922.  
  923.  
  924.  
  925.  
  926.  
  927.  
  928.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  929.  
  930.  
  931.  
  932.                 "C-Q"                    ->  quoted-insert
  933.                 "C-R"                    ->  reverse-search-history
  934.                 "C-S"                    ->  forward-search-history
  935.                 "C-T"                    ->  transpose-chars
  936.                 "C-U"                    ->  unix-line-discard
  937.                 "C-V"                    ->  quoted-insert
  938.                 "C-W"                    ->  unix-word-rubout
  939.                 "C-Y"                    ->  yank
  940.                 "C-["                    ->  vi-movement-mode
  941.                 " " to "~"               ->  self-insert
  942.                 "C-?"                    ->  backward-delete-char
  943.  
  944.                 VI Command Mode functions
  945.  
  946.                 "C-D"                    ->  vi-eof-maybe
  947.                 "C-E"                    ->  emacs-editing-mode
  948.                 "C-G"                    ->  abort
  949.                 "C-H"                    ->  backward-char
  950.                 "C-J"                    ->  accept-line
  951.                 "C-K"                    ->  kill-line
  952.                 "C-L"                    ->  clear-screen
  953.                 "C-M"                    ->  accept-line
  954.                 "C-N"                    ->  next-history
  955.                 "C-P"                    ->  previous-history
  956.                 "C-Q"                    ->  quoted-insert
  957.                 "C-R"                    ->  reverse-search-history
  958.                 "C-S"                    ->  forward-search-history
  959.                 "C-T"                    ->  transpose-chars
  960.                 "C-U"                    ->  unix-line-discard
  961.                 "C-V"                    ->  quoted-insert
  962.                 "C-W"                    ->  unix-word-rubout
  963.                 "C-Y"                    ->  yank
  964.                 "C-["                    ->  abort
  965.                 " "                      ->  forward-char
  966.                 "#"                      ->  vi-comment
  967.                 "$"                      ->  end-of-line
  968.                 "%"                      ->  vi-match
  969.                 "&"                      ->  vi-tilde-expand
  970.                 "*"                      ->  vi-complete
  971.                 "+"                      ->  down-history
  972.                 ","                      ->  vi-char-search
  973.                 "-"                      ->  previous-history
  974.                 "."                      ->  vi-redo
  975.                 "/"                      ->  vi-search
  976.                 "0"                      ->  beginning-of-line
  977.                 "1" to "9"               ->  vi-arg-digit
  978.                 ";"                      ->  vi-char-search
  979.                 "="                      ->  vi-complete
  980.                 "?"                      ->  vi-search
  981.                 "@"                      ->  is undefined
  982.                 "A"                      ->  vi-append-eol
  983.                 "B"                      ->  vi-prev-word
  984.  
  985.  
  986.  
  987.      Page 15                                         (printed 7/10/95)
  988.  
  989.  
  990.  
  991.  
  992.  
  993.  
  994.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  995.  
  996.  
  997.  
  998.                 "C"                      ->  vi-change-to
  999.                 "D"                      ->  vi-delete-to
  1000.                 "E"                      ->  vi-end-word
  1001.                 "F"                      ->  vi-char-search
  1002.                 "I"                      ->  vi-insert-beg
  1003.                 "N"                      ->  vi-search-again
  1004.                 "P"                      ->  vi-put
  1005.                 "R"                      ->  vi-replace
  1006.                 "S"                      ->  vi-subst
  1007.                 "T"                      ->  vi-char-search
  1008.                 "U"                      ->  revert-line
  1009.                 "W"                      ->  vi-next-word
  1010.                 "X"                      ->  backward-delete-char
  1011.                 "Y"                      ->  vi-yank-to
  1012.                 "\"                      ->  vi-complete
  1013.                 "^"                      ->  vi-first-print
  1014.                 "_"                      ->  vi-yank-arg
  1015.                 "a"                      ->  vi-append-mode
  1016.                 "b"                      ->  vi-prev-word
  1017.                 "c"                      ->  vi-change-to
  1018.                 "d"                      ->  vi-delete-to
  1019.                 "e"                      ->  vi-end-word
  1020.                 "f"                      ->  vi-char-search
  1021.                 "h"                      ->  backward-char
  1022.                 "i"                      ->  vi-insertion-mode
  1023.                 "j"                      ->  next-history
  1024.                 "k"                      ->  prev-history
  1025.                 "l"                      ->  forward-char
  1026.                 "n"                      ->  vi-search-again
  1027.                 "r"                      ->  vi-change-char
  1028.                 "s"                      ->  vi-subst
  1029.                 "t"                      ->  vi-char-search
  1030.                 "u"                      ->  undo
  1031.                 "w"                      ->  vi-next-word
  1032.                 "x"                      ->  vi-delete
  1033.                 "y"                      ->  vi-yank-to
  1034.                 "|"                      ->  vi-column
  1035.                 "~"                      ->  vi-change-case
  1036.  
  1037.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  1038.           _T_h_e _G_n_u _R_e_a_d_l_i_n_e _L_i_b_r_a_r_y, Brian Fox and Chet Ramey
  1039.           _T_h_e _G_n_u _H_i_s_t_o_r_y _L_i_b_r_a_r_y, Brian Fox and Chet Ramey
  1040.           _b_a_s_h(1)
  1041.  
  1042.      FFFFIIIILLLLEEEESSSS
  1043.           ~/._i_n_p_u_t_r_c
  1044.                Individual rrrreeeeaaaaddddlllliiiinnnneeee initialization file
  1045.  
  1046.      AAAAUUUUTTTTHHHHOOOORRRRSSSS
  1047.                Brian Fox, Free Software Foundation (primary author)
  1048.                bfox@ai.MIT.Edu
  1049.  
  1050.  
  1051.  
  1052.  
  1053.      Page 16                                         (printed 7/10/95)
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuullllyyyy 22226666))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  1061.  
  1062.  
  1063.  
  1064.                Chet Ramey, Case Western Reserve University
  1065.                chet@ins.CWRU.Edu
  1066.  
  1067.      BBBBUUUUGGGG RRRREEEEPPPPOOOORRRRTTTTSSSS
  1068.           If you find a bug in rrrreeeeaaaaddddlllliiiinnnneeee,,,, you should report it.  But
  1069.           first, you should make sure that it really is a bug, and
  1070.           that it appears in the latest version of the rrrreeeeaaaaddddlllliiiinnnneeee
  1071.           library that you have.
  1072.  
  1073.           Once you have determined that a bug actually exists, mail a
  1074.           bug report to _b_a_s_h-_m_a_i_n_t_a_i_n_e_r_s@_p_r_e_p._a_i._M_I_T._E_d_u.  If you have
  1075.           a fix, you are welcome to mail that as well!  Suggestions
  1076.           and `philosophical' bug reports may be mailed to _b_u_g-
  1077.           _b_a_s_h@_p_r_e_p._a_i._M_I_T._E_d_u or posted to the Usenet newsgroup
  1078.           ggggnnnnuuuu....bbbbaaaasssshhhh....bbbbuuuugggg.
  1079.  
  1080.           Comments and bug reports concerning this manual page should
  1081.           be directed to _c_h_e_t@_i_n_s._C_W_R_U._E_d_u.
  1082.  
  1083.      BBBBUUUUGGGGSSSS
  1084.           It's too big and too slow.
  1085.  
  1086.  
  1087.  
  1088.  
  1089.  
  1090.  
  1091.  
  1092.  
  1093.  
  1094.  
  1095.  
  1096.  
  1097.  
  1098.  
  1099.  
  1100.  
  1101.  
  1102.  
  1103.  
  1104.  
  1105.  
  1106.  
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.  
  1119.      Page 17                                         (printed 7/10/95)
  1120.  
  1121.  
  1122.  
  1123.